Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DataGridPro] Fix the return type of useGridApiRef for Pro and Premium packages on React < 19 #16328

Merged
merged 2 commits into from
Jan 27, 2025
Merged

[DataGridPro] Fix the return type of useGridApiRef for Pro and Premium packages on React < 19 #16328

merged 2 commits into from
Jan 27, 2025
+8 −4

Conversation

arminmeh
Copy link
Contributor

Re-exported hook needs to be explicitly typed again to prevent type evaluation during build time to React.RefObject

Content of useGridApiRef.d.ts for the Pro package

before changes:

import { GridApiPro } from '../../models/gridApiPro';
export declare const useGridApiRef: () => import("react").RefObject<GridApiPro>;

after changes:

import { RefObject } from '@mui/x-internals/types';
import { GridApiCommon } from '@mui/x-data-grid';
import { GridApiPro } from '../../models/gridApiPro';
export declare const useGridApiRef: <Api extends GridApiCommon = GridApiPro>() => RefObject<Api>;

@arminmeh arminmeh added bug 🐛 Something doesn't work component: data grid This is the name of the generic UI component, not the React module! typescript plan: Pro Impact at least one Pro user needs cherry-pick The PR should be cherry-picked to master after merge v7.x labels Jan 24, 2025
@arminmeh arminmeh requested a review from a team January 24, 2025 15:01
@arminmeh arminmeh mentioned this pull request Jan 24, 2025
Merged
@mui-bot
Copy link

mui-bot commented Jan 24, 2025 •
edited
Loading

Deploy preview: https://deploy-preview-16328--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 215aab1

@arminmeh arminmeh mentioned this pull request Jan 25, 2025
Closed
@arminmeh arminmeh enabled auto-merge (squash) January 27, 2025 07:55
@arminmeh arminmeh merged commit f4923d6 into mui:master Jan 27, 2025
16 checks passed
@github-actions GitHub Actions
Copy link

Cherry-pick PRs will be created targeting branches: v7.x

github-actions bot pushed a commit that referenced this pull request Jan 27, 2025
@arminmeh @web-flow
[DataGridPro] Fix the return type of useGridApiRef for Pro and Prem…
ddaf82e 
…ium packages on React < 19 (#16328)
@github-actions github-actions bot mentioned this pull request Jan 27, 2025
Merged
@arminmeh arminmeh mentioned this pull request Jan 27, 2025
Closed
@arminmeh arminmeh deleted the fix-apiref-pro-premium branch January 27, 2025 19:11
@genepaul
Copy link
Contributor

I'm still seeing the type issue on 7.24.1 and React 18.

image

This was after a package-lock update from 7.23.6 to 7.24.1.

System:
    OS: macOS 14.5
  Binaries:
    Node: 20.12.1 - ~/.nvm/versions/node/v20.12.1/bin/node
    npm: 10.9.2 - ~/Developer/component-library/node_modules/.bin/npm
    pnpm: 9.6.0 - /opt/homebrew/bin/pnpm
  Browsers:
    Chrome: 132.0.6834.111
    Edge: 132.0.2957.127
    Safari: 17.5
  npmPackages:
    @emotion/react:  11.14.0 
    @emotion/styled:  11.14.0 
    @mui/base:  5.0.0-beta.42 
    @mui/core-downloads-tracker:  6.4.1 
    @mui/icons-material: ^6.1.0 => 6.4.1 
    @mui/lab: 6.0.0-dev.240424162023-9968b4889d => 6.0.0-dev.240424162023-9968b4889d 
    @mui/material:  6.4.1 
    @mui/private-theming:  6.4.1 
    @mui/styled-engine:  6.4.0 
    @mui/system: ^6.0.2 => 6.4.1 
    @mui/types:  7.2.21 
    @mui/utils: ^6.1.6 => 6.4.1 
    @mui/x-data-grid:  7.24.1 
    @mui/x-data-grid-premium: ^7.4.0 => 7.24.1 
    @mui/x-data-grid-pro:  7.24.1 
    @mui/x-date-pickers: ^7.0.0 => 7.24.1 
    @mui/x-date-pickers-pro: ^7.0.0 => 7.24.1 
    @mui/x-internals:  7.24.1 
    @mui/x-license: ^7.0.0 => 7.24.1 
    @types/react: 18.3.18 => 18.3.18 
    react: 18.3.1 => 18.3.1 
    react-dom: 18.3.1 => 18.3.1 
    typescript: 5.7.3 => 5.7.3

@cherniavskii
Copy link
Member

@genepaul Correct, this PR was merged yesterday and hasn't been released yet. The next release is planned for Thursday.
Meanwhile, you can give it a try by using packages from Codesandbox CI build for this PR: https://ci.codesandbox.io/status/mui/mui-x/pr/16348/builds/582145?pr=16328

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MBilalShafi MBilalShafi MBilalShafi approved these changes

Assignees
No one assigned
Labels
bug 🐛 Something doesn't work component: data grid This is the name of the generic UI component, not the React module! needs cherry-pick The PR should be cherry-picked to master after merge plan: Pro Impact at least one Pro user typescript v7.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@arminmeh @mui-bot @genepaul @cherniavskii @MBilalShafi